

<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Document</title>
    <style>
    /* base */
    html,
    body,
    .container {
      width: 100%;
      height: 100%;
    }

    a,
    a:link,
    a:visited {
      text-decoration: none;
      color: inherit;
    }

    ul {
      list-style: none;
    }

    *,
    ::before,
    ::after {
      box-sizing: border-box;
      margin: 0;
      padding: 0;
    }

    *:focus {
      outline: 0;
    }

    .container {
      display: flex;
      padding-top: 20px;
    }

    /* Nav */
    .container .doc-nav {
      position: fixed;
      height: 100%;
      margin: 0 30px 0 40px;
      width: 280px;
    }

    .doc-nav .nav-header {
      display: flex;
      align-items: center;
      box-sizing: border-box;
      background-color: rgb(240, 241, 242);
      height: 40px;
      padding: 16px;
      font-size: 18px;
      font-weight: 500;
      color: rgb(62, 64, 66);
      cursor: pointer;
    }

    .doc-nav .nav-content {
      height: calc(100% - 40px);
      overflow-y: auto;
      color: rgb(32, 34, 36);
    }

    .doc-nav .nav-content .nav-list,
    .doc-nav .nav-content .nav-sub-list {
      line-height: 1.5rem;
    }

    .doc-nav .nav-content .nav-label {
      display: inline-block;
      position: relative;
      padding: 2px 0 2px 20px;
      margin-bottom: 4px;
    }

    .doc-nav .nav-content .nav-sub-label {
      position: relative;
      padding: 2px 0 2px 40px;
      font-size: 14px;
    }

    .doc-nav .nav-content .nav-sub-label:hover {
      text-decoration: underline;
    }

    .doc-nav .nav-content .nav-list .nav-label.group::before {
      border-bottom: 0.25rem solid transparent;
      border-left: 0.25rem solid #6e7072;
      border-right: 0;
      border-top: 0.25rem solid transparent;
      content: '';
      display: block;
      height: 0;
      left: 0.5rem;
      position: absolute;
      top: 0.625rem;
      transition: transform 0.1s linear;
      width: 0;
    }

    .doc-nav .nav-content .nav-list .nav-label.group.active::before {
      transform: rotate(90deg);
    }

    /* doc content */
    .container .doc-content {
      position: fixed;
      height: 100%;
      width: calc(100% - 80px - 40px - 30px - 240px);
      right: 0%;
      overflow-y: auto;
    }

    .doc-title {
      border-bottom: 1px solid #dcdee0;
      font-size: 22px;
      margin: 8px 0 0;
      padding-bottom: 16px;
    }

    .doc-content h3 {
      font-size: 24px;
      font-weight: 600;
      margin: 24px 0;
    }

    .doc-content h4 {
      font-size: 22px;
      font-weight: 500;
      margin: 30px 0 8px;
    }

    .doc-content h4 span {
      color: #007d9c;
    }

    .doc-content .doc-declare {
      background-color: #fafafa;
      border-radius: 5px;
      border: 1px solid #ccc;
      font-size: 14px;
      overflow-x: auto;
      padding: 10px;
      tab-size: 4;
      line-height: 20px;
    }

    .doc-content .doc-comment {
      font-size: 16px;
      margin: 16px 0;
      line-height: 24px;
      word-break: break-word;
    }
  </style>

</head>
<body>
  <div class="container">
    <div class="doc-nav">
      <a href="#Documentation" class="nav-header">Documentation</a>
      <nav class="nav-content">
        <ul class="nav-list">
          <li>
            <a href="#includes" class="nav-label">Includes</a>
             
            <ul class="nav-sub-list">

              <li>
                <a href="#config.h" class="nav-sub-label">config.h</a>
              </li>
      

              <li>
                <a href="#MBEDTLS_CONFIG_FILE" class="nav-sub-label">MBEDTLS_CONFIG_FILE</a>
              </li>
      

              <li>
                <a href="#x509.h" class="nav-sub-label">x509.h</a>
              </li>
      
            </ul>
            
          </li>
          <li>
            <a href="#macros" class="nav-label">Macros</a>
             
            <ul class="nav-sub-list">

              <li>
                <a href="#MBEDTLS_X509_CSR_H" class="nav-sub-label">MBEDTLS_X509_CSR_H</a>
              </li>
      
            </ul>
            
          </li>
          <li>
            <a href="#functions" class="nav-label">Functions</a>
             
            <ul class="nav-sub-list">

              <li>
                <a href="#mbedtls_x509_csr_parse_der" class="nav-sub-label">mbedtls_x509_csr_parse_der</a>
              </li>
      

              <li>
                <a href="#mbedtls_x509_csr_parse" class="nav-sub-label">mbedtls_x509_csr_parse</a>
              </li>
      

              <li>
                <a href="#mbedtls_x509_csr_parse_file" class="nav-sub-label">mbedtls_x509_csr_parse_file</a>
              </li>
      

              <li>
                <a href="#mbedtls_x509_csr_info" class="nav-sub-label">mbedtls_x509_csr_info</a>
              </li>
      

              <li>
                <a href="#mbedtls_x509_csr_init" class="nav-sub-label">mbedtls_x509_csr_init</a>
              </li>
      

              <li>
                <a href="#mbedtls_x509_csr_free" class="nav-sub-label">mbedtls_x509_csr_free</a>
              </li>
      

              <li>
                <a href="#mbedtls_x509write_csr_init" class="nav-sub-label">mbedtls_x509write_csr_init</a>
              </li>
      

              <li>
                <a href="#mbedtls_x509write_csr_set_subject_name" class="nav-sub-label">mbedtls_x509write_csr_set_subject_name</a>
              </li>
      

              <li>
                <a href="#mbedtls_x509write_csr_set_key" class="nav-sub-label">mbedtls_x509write_csr_set_key</a>
              </li>
      

              <li>
                <a href="#mbedtls_x509write_csr_set_md_alg" class="nav-sub-label">mbedtls_x509write_csr_set_md_alg</a>
              </li>
      

              <li>
                <a href="#mbedtls_x509write_csr_set_key_usage" class="nav-sub-label">mbedtls_x509write_csr_set_key_usage</a>
              </li>
      

              <li>
                <a href="#mbedtls_x509write_csr_set_ns_cert_type" class="nav-sub-label">mbedtls_x509write_csr_set_ns_cert_type</a>
              </li>
      

              <li>
                <a href="#mbedtls_x509write_csr_set_extension" class="nav-sub-label">mbedtls_x509write_csr_set_extension</a>
              </li>
      

              <li>
                <a href="#mbedtls_x509write_csr_free" class="nav-sub-label">mbedtls_x509write_csr_free</a>
              </li>
      

              <li>
                <a href="#mbedtls_x509write_csr_der" class="nav-sub-label">mbedtls_x509write_csr_der</a>
              </li>
      

              <li>
                <a href="#mbedtls_x509write_csr_pem" class="nav-sub-label">mbedtls_x509write_csr_pem</a>
              </li>
      
            </ul>
            
          </li>
          <li>
            <a href="#vars" class="nav-label">Vars</a>
            
            <ul class="nav-sub-list">
            
            </ul>
            
          </li>
          <li>
            <a href="#consts" class="nav-label">Consts</a>
            
            <ul class="nav-sub-list">
            
            </ul>
            
          </li>
          <li>
            <a href="#types" class="nav-label">Types</a>
            
            <ul class="nav-sub-list">
            
            </ul>
            
          </li>
          <li>
            <a href="#typedefs" class="nav-label">Typedefs</a>
             
            <ul class="nav-sub-list">

              <li>
                <a href="#
mbedtls_x509_csr;
" class="nav-sub-label">
mbedtls_x509_csr;
</a>
              </li>
      

              <li>
                <a href="#
mbedtls_x509write_csr;
" class="nav-sub-label">
mbedtls_x509write_csr;
</a>
              </li>
      
            </ul>
            
          </li>
        </ul>
      </nav>
    </div>
    <div class="doc-content">
      <h2 id="Documentation" class="doc-title">Documentation</h2>
      <h3 id="includes">Includes</h3>
      

      <h4 id="config.h"><span>config.h</span></h4>
      <pre class="doc-declare"><code>#include "config.h"
</code></pre>
      <pre class="doc-comment">#include "config.h"
</pre>

      <h4 id="MBEDTLS_CONFIG_FILE"><span>MBEDTLS_CONFIG_FILE</span></h4>
      <pre class="doc-declare"><code>#include MBEDTLS_CONFIG_FILE
</code></pre>
      <pre class="doc-comment">#include MBEDTLS_CONFIG_FILE
</pre>

      <h4 id="x509.h"><span>x509.h</span></h4>
      <pre class="doc-declare"><code>#include "x509.h"
</code></pre>
      <pre class="doc-comment">#include "x509.h"
</pre>
      <h3 id="macros">Macros</h3>
      

      <h4 id="MBEDTLS_X509_CSR_H">Marco <span>MBEDTLS_X509_CSR_H</span></h4>
      <pre class="doc-declare"><code>#define MBEDTLS_X509_CSR_H
</code></pre>
      <pre class="doc-comment"></pre>
      <h3 id="functions">Functions</h3>
      

      <h4 id="mbedtls_x509_csr_parse_der">Func <span>mbedtls_x509_csr_parse_der</span></h4>
      <pre class="doc-declare"><code>int mbedtls_x509_csr_parse_der( mbedtls_x509_csr *csr,
                       const unsigned char *buf, size_t buflen );</code></pre>
      <pre class="doc-comment">/**
 * \brief          Load a Certificate Signing Request (CSR) in DER format
 *
 * \note           CSR attributes (if any) are currently silently ignored.
 *
 * \param csr      CSR context to fill
 * \param buf      buffer holding the CRL data
 * \param buflen   size of the buffer
 *
 * \return         0 if successful, or a specific X509 error code
 */</pre>

      <h4 id="mbedtls_x509_csr_parse">Func <span>mbedtls_x509_csr_parse</span></h4>
      <pre class="doc-declare"><code>int mbedtls_x509_csr_parse( mbedtls_x509_csr *csr, const unsigned char *buf, size_t buflen );</code></pre>
      <pre class="doc-comment">/**
 * \brief          Load a Certificate Signing Request (CSR), DER or PEM format
 *
 * \note           See notes for \c mbedtls_x509_csr_parse_der()
 *
 * \param csr      CSR context to fill
 * \param buf      buffer holding the CRL data
 * \param buflen   size of the buffer
 *                 (including the terminating null byte for PEM data)
 *
 * \return         0 if successful, or a specific X509 or PEM error code
 */</pre>

      <h4 id="mbedtls_x509_csr_parse_file">Func <span>mbedtls_x509_csr_parse_file</span></h4>
      <pre class="doc-declare"><code>int mbedtls_x509_csr_parse_file( mbedtls_x509_csr *csr, const char *path );</code></pre>
      <pre class="doc-comment">/**
 * \brief          Load a Certificate Signing Request (CSR)
 *
 * \note           See notes for \c mbedtls_x509_csr_parse()
 *
 * \param csr      CSR context to fill
 * \param path     filename to read the CSR from
 *
 * \return         0 if successful, or a specific X509 or PEM error code
 */</pre>

      <h4 id="mbedtls_x509_csr_info">Func <span>mbedtls_x509_csr_info</span></h4>
      <pre class="doc-declare"><code>int mbedtls_x509_csr_info( char *buf, size_t size, const char *prefix,
                  const mbedtls_x509_csr *csr );</code></pre>
      <pre class="doc-comment">/**
 * \brief          Returns an informational string about the
 *                 CSR.
 *
 * \param buf      Buffer to write to
 * \param size     Maximum size of buffer
 * \param prefix   A line prefix
 * \param csr      The X509 CSR to represent
 *
 * \return         The length of the string written (not including the
 *                 terminated nul byte), or a negative error code.
 */</pre>

      <h4 id="mbedtls_x509_csr_init">Func <span>mbedtls_x509_csr_init</span></h4>
      <pre class="doc-declare"><code>void mbedtls_x509_csr_init( mbedtls_x509_csr *csr );</code></pre>
      <pre class="doc-comment">/**
 * \brief          Initialize a CSR
 *
 * \param csr      CSR to initialize
 */</pre>

      <h4 id="mbedtls_x509_csr_free">Func <span>mbedtls_x509_csr_free</span></h4>
      <pre class="doc-declare"><code>void mbedtls_x509_csr_free( mbedtls_x509_csr *csr );</code></pre>
      <pre class="doc-comment">/**
 * \brief          Unallocate all CSR data
 *
 * \param csr      CSR to free
 */</pre>

      <h4 id="mbedtls_x509write_csr_init">Func <span>mbedtls_x509write_csr_init</span></h4>
      <pre class="doc-declare"><code>void mbedtls_x509write_csr_init( mbedtls_x509write_csr *ctx );</code></pre>
      <pre class="doc-comment">/**
 * \brief           Initialize a CSR context
 *
 * \param ctx       CSR context to initialize
 */</pre>

      <h4 id="mbedtls_x509write_csr_set_subject_name">Func <span>mbedtls_x509write_csr_set_subject_name</span></h4>
      <pre class="doc-declare"><code>int mbedtls_x509write_csr_set_subject_name( mbedtls_x509write_csr *ctx,
                                   const char *subject_name );</code></pre>
      <pre class="doc-comment">/**
 * \brief           Set the subject name for a CSR
 *                  Subject names should contain a comma-separated list
 *                  of OID types and values:
 *                  e.g. "C=UK,O=ARM,CN=mbed TLS Server 1"
 *
 * \param ctx           CSR context to use
 * \param subject_name  subject name to set
 *
 * \return          0 if subject name was parsed successfully, or
 *                  a specific error code
 */</pre>

      <h4 id="mbedtls_x509write_csr_set_key">Func <span>mbedtls_x509write_csr_set_key</span></h4>
      <pre class="doc-declare"><code>void mbedtls_x509write_csr_set_key( mbedtls_x509write_csr *ctx, mbedtls_pk_context *key );</code></pre>
      <pre class="doc-comment">/**
 * \brief           Set the key for a CSR (public key will be included,
 *                  private key used to sign the CSR when writing it)
 *
 * \param ctx       CSR context to use
 * \param key       Asymetric key to include
 */</pre>

      <h4 id="mbedtls_x509write_csr_set_md_alg">Func <span>mbedtls_x509write_csr_set_md_alg</span></h4>
      <pre class="doc-declare"><code>void mbedtls_x509write_csr_set_md_alg( mbedtls_x509write_csr *ctx, mbedtls_md_type_t md_alg );</code></pre>
      <pre class="doc-comment">/**
 * \brief           Set the MD algorithm to use for the signature
 *                  (e.g. MBEDTLS_MD_SHA1)
 *
 * \param ctx       CSR context to use
 * \param md_alg    MD algorithm to use
 */</pre>

      <h4 id="mbedtls_x509write_csr_set_key_usage">Func <span>mbedtls_x509write_csr_set_key_usage</span></h4>
      <pre class="doc-declare"><code>int mbedtls_x509write_csr_set_key_usage( mbedtls_x509write_csr *ctx, unsigned char key_usage );</code></pre>
      <pre class="doc-comment">/**
 * \brief           Set the Key Usage Extension flags
 *                  (e.g. MBEDTLS_X509_KU_DIGITAL_SIGNATURE | MBEDTLS_X509_KU_KEY_CERT_SIGN)
 *
 * \param ctx       CSR context to use
 * \param key_usage key usage flags to set
 *
 * \return          0 if successful, or MBEDTLS_ERR_X509_ALLOC_FAILED
 *
 * \note            The <code>decipherOnly</code> flag from the Key Usage
 *                  extension is represented by bit 8 (i.e.
 *                  <code>0x8000</code>), which cannot typically be represented
 *                  in an unsigned char. Therefore, the flag
 *                  <code>decipherOnly</code> (i.e.
 *                  #MBEDTLS_X509_KU_DECIPHER_ONLY) cannot be set using this
 *                  function.
 */</pre>

      <h4 id="mbedtls_x509write_csr_set_ns_cert_type">Func <span>mbedtls_x509write_csr_set_ns_cert_type</span></h4>
      <pre class="doc-declare"><code>int mbedtls_x509write_csr_set_ns_cert_type( mbedtls_x509write_csr *ctx,
                                   unsigned char ns_cert_type );</code></pre>
      <pre class="doc-comment">/**
 * \brief           Set the Netscape Cert Type flags
 *                  (e.g. MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT | MBEDTLS_X509_NS_CERT_TYPE_EMAIL)
 *
 * \param ctx           CSR context to use
 * \param ns_cert_type  Netscape Cert Type flags to set
 *
 * \return          0 if successful, or MBEDTLS_ERR_X509_ALLOC_FAILED
 */</pre>

      <h4 id="mbedtls_x509write_csr_set_extension">Func <span>mbedtls_x509write_csr_set_extension</span></h4>
      <pre class="doc-declare"><code>int mbedtls_x509write_csr_set_extension( mbedtls_x509write_csr *ctx,
                                const char *oid, size_t oid_len,
                                const unsigned char *val, size_t val_len );</code></pre>
      <pre class="doc-comment">/**
 * \brief           Generic function to add to or replace an extension in the
 *                  CSR
 *
 * \param ctx       CSR context to use
 * \param oid       OID of the extension
 * \param oid_len   length of the OID
 * \param val       value of the extension OCTET STRING
 * \param val_len   length of the value data
 *
 * \return          0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED
 */</pre>

      <h4 id="mbedtls_x509write_csr_free">Func <span>mbedtls_x509write_csr_free</span></h4>
      <pre class="doc-declare"><code>void mbedtls_x509write_csr_free( mbedtls_x509write_csr *ctx );</code></pre>
      <pre class="doc-comment">/**
 * \brief           Free the contents of a CSR context
 *
 * \param ctx       CSR context to free
 */</pre>

      <h4 id="mbedtls_x509write_csr_der">Func <span>mbedtls_x509write_csr_der</span></h4>
      <pre class="doc-declare"><code>int mbedtls_x509write_csr_der( mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size,
                      int (*f_rng)(void *, unsigned char *, size_t),
                      void *p_rng );</code></pre>
      <pre class="doc-comment">/**
 * \brief           Write a CSR (Certificate Signing Request) to a
 *                  DER structure
 *                  Note: data is written at the end of the buffer! Use the
 *                        return value to determine where you should start
 *                        using the buffer
 *
 * \param ctx       CSR to write away
 * \param buf       buffer to write to
 * \param size      size of the buffer
 * \param f_rng     RNG function (for signature, see note)
 * \param p_rng     RNG parameter
 *
 * \return          length of data written if successful, or a specific
 *                  error code
 *
 * \note            f_rng may be NULL if RSA is used for signature and the
 *                  signature is made offline (otherwise f_rng is desirable
 *                  for countermeasures against timing attacks).
 *                  ECDSA signatures always require a non-NULL f_rng.
 */</pre>

      <h4 id="mbedtls_x509write_csr_pem">Func <span>mbedtls_x509write_csr_pem</span></h4>
      <pre class="doc-declare"><code>int mbedtls_x509write_csr_pem( mbedtls_x509write_csr *ctx, unsigned char *buf, size_t size,
                      int (*f_rng)(void *, unsigned char *, size_t),
                      void *p_rng );</code></pre>
      <pre class="doc-comment">/**
 * \brief           Write a CSR (Certificate Signing Request) to a
 *                  PEM string
 *
 * \param ctx       CSR to write away
 * \param buf       buffer to write to
 * \param size      size of the buffer
 * \param f_rng     RNG function (for signature, see note)
 * \param p_rng     RNG parameter
 *
 * \return          0 if successful, or a specific error code
 *
 * \note            f_rng may be NULL if RSA is used for signature and the
 *                  signature is made offline (otherwise f_rng is desirable
 *                  for countermeasures against timing attacks).
 *                  ECDSA signatures always require a non-NULL f_rng.
 */</pre>
      <h3 id="vars">Vars</h3>
      
      <h3 id="consts">Consts</h3>
      
      <h3 id="types">Types</h3>
      
      <h3 id="typedefs">Typedefs</h3>
      

      <h4 id="
mbedtls_x509_csr;
">Typedef <span>
mbedtls_x509_csr;
</span></h4>
      <pre class="doc-declare"><code>typedef struct mbedtls_x509_csr
{
   mbedtls_x509_buf raw;          /**< The raw CSR data (DER). */
   mbedtls_x509_buf cri;          /**< The raw CertificateRequestInfo body (DER). */

   int version;           /**< CSR version (1=v1). */

   mbedtls_x509_buf subject_raw; /**< The raw subject data (DER). */
   mbedtls_x509_name subject;     /**< The parsed subject data (named information object). */

   mbedtls_pk_context pk;         /**< Container for the public key context. */

   mbedtls_x509_buf sig_oid;
   mbedtls_x509_buf sig;
   mbedtls_md_type_t sig_md;      /**< Internal representation of the MD algorithm of the signature algorithm, e.g. MBEDTLS_MD_SHA256 */
   mbedtls_pk_type_t sig_pk;      /**< Internal representation of the Public Key algorithm of the signature algorithm, e.g. MBEDTLS_PK_RSA */
   void *sig_opts;        /**< Signature options to be passed to mbedtls_pk_verify_ext(), e.g. for RSASSA-PSS */
}
mbedtls_x509_csr;
</code></pre>
      <pre class="doc-comment">/**
 * Certificate Signing Request (CSR) structure.
 */</pre>

      <h4 id="
mbedtls_x509write_csr;
">Typedef <span>
mbedtls_x509write_csr;
</span></h4>
      <pre class="doc-declare"><code>typedef struct mbedtls_x509write_csr
{
   mbedtls_pk_context *key;
   mbedtls_asn1_named_data *subject;
   mbedtls_md_type_t md_alg;
   mbedtls_asn1_named_data *extensions;
}
mbedtls_x509write_csr;
</code></pre>
      <pre class="doc-comment">/**
 * Container for writing a CSR
 */</pre>
    </div>
  </body>
</html>
            